/*++

Copyright (c) 2005 - 2006, Intel Corporation                                                         
All rights reserved. This program and the accompanying materials                          
are licensed and made available under the terms and conditions of the BSD License         
which accompanies this distribution.  The full text of the license may be found at        
http://opensource.org/licenses/bsd-license.php                                            
                                                                                          
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 


Module Name:

  Ip4Route.c

Abstract:

--*/

#include "Ip4Impl.h"

STATIC
IP4_ROUTE_ENTRY *
Ip4CreateRouteEntry (
  IN IP4_ADDR               Dest,
  IN IP4_ADDR               Netmask,
  IN IP4_ADDR               GateWay
  )
/*++

Routine Description:

  Allocate a route entry then initialize it with the Dest/Netmaks 
  and Gateway.

Arguments:

  Dest     - The destination network
  Netmask  - The destination network mask
  GateWay  - The nexthop address

Returns:

  NULL if failed to allocate memeory, otherwise the newly created
  route entry. 

--*/
{
  IP4_ROUTE_ENTRY           *RtEntry;

  RtEntry = NetAllocatePool (sizeof (IP4_ROUTE_ENTRY));

  if (RtEntry == NULL) {
    return NULL;
  }

  NetListInit (&RtEntry->Link);

  RtEntry->RefCnt  = 1;
  RtEntry->Dest    = Dest;
  RtEntry->Netmask = Netmask;
  RtEntry->NextHop = GateWay;
  RtEntry->Flag    = 0;

  return RtEntry;
}

STATIC
VOID
Ip4FreeRouteEntry (
  IN IP4_ROUTE_ENTRY    *RtEntry
  )
/*++

Routine Description:

  Free the route table entry. It is reference counted.

Arguments:

  RtEntry - The route entry to free.

Returns:

  NONE

--*/
{
  ASSERT (RtEntry->RefCnt > 0);

  if (--RtEntry->RefCnt == 0) {
    NetFreePool (RtEntry);
  }
}

STATIC
IP4_ROUTE_CACHE_ENTRY *
Ip4CreateRouteCacheEntry (
  IN IP4_ADDR               Dst,
  IN IP4_ADDR               Src,
  IN IP4_ADDR               GateWay,
  IN UINTN                  Tag
  )
/*++

Routine Description:

  Allocate and initialize a IP4 route cache entry.

Arguments:

  Dst     - The destination address
  Src     - The source address
  GateWay - The next hop address
  Tag     - The tag from the caller. This marks all the cache entries
            spawned from one route table entry.

Returns:

  NULL if failed to allocate memory for the cache, other point
  to the created route cache entry.

--*/
{
  IP4_ROUTE_CACHE_ENTRY     *RtCacheEntry;

  RtCacheEntry = NetAllocatePool (sizeof (IP4_ROUTE_CACHE_ENTRY));

  if (RtCacheEntry == NULL) {
    return NULL;
  }

  NetListInit (&RtCacheEntry->Link);

  RtCacheEntry->RefCnt  = 1;
  RtCacheEntry->Dest    = Dst;
  RtCacheEntry->Src     = Src;
  RtCacheEntry->NextHop = GateWay;
  RtCacheEntry->Tag     = Tag;

  return RtCacheEntry;
}

VOID
Ip4FreeRouteCacheEntry (
  IN IP4_ROUTE_CACHE_ENTRY  *RtCacheEntry
  )
/*++

Routine Description:

  Free the route cache entry. It is reference counted.

Arguments:

  RtCacheEntry  - The route cache entry to free.

Returns:

  None

--*/
{
  ASSERT (RtCacheEntry->RefCnt > 0);

  if (--RtCacheEntry->RefCnt == 0) {
    NetFreePool (RtCacheEntry);
  }
}

VOID
Ip4InitRouteCache (
  IN IP4_ROUTE_CACHE        *RtCache
  )
/*++

Routine Description:

  Initialize an empty route cache table.

Arguments:

  RtCache - The rotue cache table to initialize.

Returns:

  NONE

--*/
{
  UINT32                    Index;

  for (Index = 0; Index < IP4_ROUTE_CACHE_HASH; Index++) {
    NetListInit (&(RtCache->CacheBucket[Index]));
  }
}

VOID
Ip4CleanRouteCache (
  IN IP4_ROUTE_CACHE        *RtCache
  )
/*++

Routine Description:

  Clean up a route cache, that is free all the route cache 
  entries enqueued in the cache.

Arguments:

  RtCache - The route cache table to clean up

Returns:

  None

--*/
{
  NET_LIST_ENTRY            *Entry;
  NET_LIST_ENTRY            *Next;
  IP4_ROUTE_CACHE_ENTRY     *RtCacheEntry;
  UINT32                    Index;

  for (Index = 0; Index < IP4_ROUTE_CACHE_HASH; Index++) {
    NET_LIST_FOR_EACH_SAFE (Entry, Next, &(RtCache->CacheBucket[Index])) {
      RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link);

      NetListRemoveEntry (Entry);
      Ip4FreeRouteCacheEntry (RtCacheEntry);
    }
  }
}


IP4_ROUTE_TABLE *
Ip4CreateRouteTable (
  VOID
  )
/*++

Routine Description:

  Create an empty route table, includes its internal route cache

Arguments:

  None

Returns:

  NULL if failed to allocate memory for the route table, otherwise
  the point to newly created route table.

--*/
{
  IP4_ROUTE_TABLE           *RtTable;
  UINT32                    Index;

  RtTable = NetAllocatePool (sizeof (IP4_ROUTE_TABLE));

  if (RtTable == NULL) {
    return NULL;
  }

  RtTable->RefCnt   = 1;
  RtTable->TotalNum = 0;

  for (Index = 0; Index < IP4_MASK_NUM; Index++) {
    NetListInit (&(RtTable->RouteArea[Index]));
  }

  RtTable->Next = NULL;

  Ip4InitRouteCache (&RtTable->Cache);
  return RtTable;
}

VOID
Ip4FreeRouteTable (
  IN IP4_ROUTE_TABLE        *RtTable
  )
/*++

Routine Description:

  Free the route table and its associated route cache. Route 
  table is reference counted.

Arguments:

  RtTable - The route table to free.

Returns:

  None
  
--*/
{
  NET_LIST_ENTRY            *Entry;
  NET_LIST_ENTRY            *Next;
  IP4_ROUTE_ENTRY           *RtEntry;
  UINT32                    Index;

  ASSERT (RtTable->RefCnt > 0);

  if (--RtTable->RefCnt > 0) {
    return ;
  }

  //
  // Free all the route table entry and its route cache.
  //
  for (Index = 0; Index < IP4_MASK_NUM; Index++) {
    NET_LIST_FOR_EACH_SAFE (Entry, Next, &(RtTable->RouteArea[Index])) {
      RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link);

      NetListRemoveEntry (Entry);
      Ip4FreeRouteEntry (RtEntry);
    }
  }

  Ip4CleanRouteCache (&RtTable->Cache);
  
  NetFreePool (RtTable);
}


STATIC
VOID
Ip4PurgeRouteCache (
  IN IP4_ROUTE_CACHE        *RtCache,
  IN UINTN                  Tag
  )
/*++

Routine Description:

  Remove all the cache entries bearing the Tag. When a route cache
  entry is created, it is tagged with the address of route entry 
  from which it is spawned. When a route entry is deleted, the cache
  entries spawned from it are also deleted.

Arguments:

  RtCache - Route cache to remove the entries from
  Tag     - The Tag of the entries to remove

Returns:

  None

--*/
{
  NET_LIST_ENTRY            *Entry;
  NET_LIST_ENTRY            *Next;
  IP4_ROUTE_CACHE_ENTRY     *RtCacheEntry;
  UINT32                    Index;

  for (Index = 0; Index < IP4_ROUTE_CACHE_HASH; Index++) {
    NET_LIST_FOR_EACH_SAFE (Entry, Next, &RtCache->CacheBucket[Index]) {

      RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link);

      if (RtCacheEntry->Tag == Tag) {
        NetListRemoveEntry (Entry);
        Ip4FreeRouteCacheEntry (RtCacheEntry);
      }
    }
  }
}

EFI_STATUS
Ip4AddRoute (
  IN IP4_ROUTE_TABLE        *RtTable,
  IN IP4_ADDR               Dest,
  IN IP4_ADDR               Netmask,
  IN IP4_ADDR               Gateway
  )
/*++

Routine Description:

  Add a route entry to the route table. All the IP4_ADDRs are in 
  host byte order.

Arguments:

  RtTable - Route table to add route to
  Dest    - The destination of the network
  Netmask - The netmask of the destination
  Gateway - The next hop address

Returns:

  EFI_ACCESS_DENIED    - The same route already exists
  EFI_OUT_OF_RESOURCES - Failed to allocate memory for the entry
  EFI_SUCCESS          - The route is added successfully.

--*/
{
  NET_LIST_ENTRY            *Head;
  NET_LIST_ENTRY            *Entry;
  IP4_ROUTE_ENTRY           *RtEntry;

  //
  // All the route entries with the same netmask length are 
  // linke to the same route area
  //
  Head = &(RtTable->RouteArea[NetGetMaskLength (Netmask)]);

  //
  // First check whether the route exists
  //
  NET_LIST_FOR_EACH (Entry, Head) {
    RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link);

    if (IP4_NET_EQUAL (RtEntry->Dest, Dest, Netmask) && (RtEntry->NextHop == Gateway)) {
      return EFI_ACCESS_DENIED;
    }
  }
  
  //
  // Create a route entry and insert it to the route area.
  //
  RtEntry = Ip4CreateRouteEntry (Dest, Netmask, Gateway);

  if (RtEntry == NULL) {
    return EFI_OUT_OF_RESOURCES;
  }

  if (Gateway == IP4_ALLZERO_ADDRESS) {
    RtEntry->Flag = IP4_DIRECT_ROUTE;
  }

  NetListInsertHead (Head, &RtEntry->Link);
  RtTable->TotalNum++;

  return EFI_SUCCESS;
}

EFI_STATUS
Ip4DelRoute (
  IN IP4_ROUTE_TABLE      *RtTable,
  IN IP4_ADDR             Dest,
  IN IP4_ADDR             Netmask,
  IN IP4_ADDR             Gateway
  )
/*++

Routine Description:

  Remove a route entry and all the route caches spawn from it.

Arguments:

  RtTable - The route table to remove the route from
  Dest    - The destination network
  Netmask - The netmask of the Dest
  Gateway - The next hop address

Returns:

  EFI_SUCCESS   - The route entry is successfully removed
  EFI_NOT_FOUND - There is no route entry in the table with that properity.

--*/
{
  NET_LIST_ENTRY            *Head;
  NET_LIST_ENTRY            *Entry;
  NET_LIST_ENTRY            *Next;
  IP4_ROUTE_ENTRY           *RtEntry;

  Head = &(RtTable->RouteArea[NetGetMaskLength (Netmask)]);

  NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) {
    RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link);

    if (IP4_NET_EQUAL (RtEntry->Dest, Dest, Netmask) && (RtEntry->NextHop == Gateway)) {
      Ip4PurgeRouteCache (&RtTable->Cache, (UINTN) RtEntry);
      NetListRemoveEntry (Entry);
      Ip4FreeRouteEntry  (RtEntry);

      RtTable->TotalNum--;
      return EFI_SUCCESS;
    }
  }

  return EFI_NOT_FOUND;
}

IP4_ROUTE_CACHE_ENTRY *
Ip4FindRouteCache (
  IN IP4_ROUTE_TABLE        *RtTable,
  IN IP4_ADDR               Dest,
  IN IP4_ADDR               Src
  )
/*++

Routine Description:

  Find a route cache with the dst and src. This is used by ICMP 
  redirect messasge process. All kinds of redirect is treated as 
  host redirect according to RFC1122. So, only route cache entries
  are modified according to the ICMP redirect message.

Arguments:

  RtTable - The route table to search the cache for
  Dest    - The destination address
  Src     - The source address

Returns:

  NULL if no route entry to the (Dest, Src). Otherwise the point
  to the correct route cache entry.

--*/
{
  NET_LIST_ENTRY            *Entry;
  IP4_ROUTE_CACHE_ENTRY     *RtCacheEntry;
  UINT32                    Index;

  Index = IP4_ROUTE_CACHE_HASH (Dest, Src);

  NET_LIST_FOR_EACH (Entry, &RtTable->Cache.CacheBucket[Index]) {
    RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link);

    if ((RtCacheEntry->Dest == Dest) && (RtCacheEntry->Src == Src)) {
      NET_GET_REF (RtCacheEntry);
      return RtCacheEntry;
    }
  }

  return NULL;
}

STATIC
IP4_ROUTE_ENTRY *
Ip4FindRouteEntry (
  IN IP4_ROUTE_TABLE        *RtTable,
  IN IP4_ADDR               Dst
  )
/*++

Routine Description:

  Search the route table for a most specific match to the Dst. It searches 
  from the longest route area (mask length == 32) to the shortest route area (
  default routes). In each route area, it will first search the instance's 
  route table, then the default route table. This is required by the following
  requirements:
    1. IP search the route table for a most specific match
    2. The local route entries have precedence over the default route entry.

Arguments:

  RtTable - The route table to search from
  Dst     - The destionation address to search 

Returns:

  NULL if no route matches the Dst, otherwise the point to the 
  most specific route to the Dst.

--*/
{
  NET_LIST_ENTRY            *Entry;
  IP4_ROUTE_ENTRY           *RtEntry;
  IP4_ROUTE_TABLE           *Table;
  INTN                      Index;

  RtEntry = NULL;
    
  for (Index = IP4_MASK_NUM - 1; Index >= 0; Index--) {
    for (Table = RtTable; Table != NULL; Table = Table->Next) {
      NET_LIST_FOR_EACH (Entry, &Table->RouteArea[Index]) {
        RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link);
        
        if (IP4_NET_EQUAL (RtEntry->Dest, Dst, RtEntry->Netmask)) {
          NET_GET_REF (RtEntry);
          return RtEntry;
        }      
      }
    }
  }


  return NULL;
}

IP4_ROUTE_CACHE_ENTRY *
Ip4Route (
  IN IP4_ROUTE_TABLE        *RtTable,
  IN IP4_ADDR               Dest,
  IN IP4_ADDR               Src
  )
/*++

Routine Description:

  Search the route table to route the packet. Return/creat a route
  cache if there is a route to the destination.

Arguments:

  RtTable  - The route table to search from
  Dest     - The destination address to search for
  Src      - The source address to search for

Returns:

  NULL if failed to route packet, otherwise a route cache 
  entry that can be used to route packet.

--*/
{
  NET_LIST_ENTRY            *Head;
  NET_LIST_ENTRY            *Entry;
  NET_LIST_ENTRY            *Next;
  IP4_ROUTE_CACHE_ENTRY     *RtCacheEntry;
  IP4_ROUTE_CACHE_ENTRY     *Cache;
  IP4_ROUTE_ENTRY           *RtEntry;
  IP4_ADDR                  NextHop;
  UINT32                    Count;

  ASSERT (RtTable != NULL);

  Head          = &RtTable->Cache.CacheBucket[IP4_ROUTE_CACHE_HASH (Dest, Src)];
  RtCacheEntry  = Ip4FindRouteCache (RtTable, Dest, Src);

  //
  // If found, promote the cache entry to the head of the hash bucket. LRU
  //
  if (RtCacheEntry != NULL) {
    NetListRemoveEntry (&RtCacheEntry->Link);
    NetListInsertHead (Head, &RtCacheEntry->Link);
    return RtCacheEntry;
  }
  
  //
  // Search the route table for the most specific route
  //
  RtEntry = Ip4FindRouteEntry (RtTable, Dest);
  
  if (RtEntry == NULL) {
    return NULL;
  }
  
  //
  // Found a route to the Dest, if it is a direct route, the packet
  // will be send directly to the destination, such as for connected
  // network. Otherwise, it is an indirect route, the packet will be
  // send the next hop router.
  //
  if (RtEntry->Flag & IP4_DIRECT_ROUTE) {
    NextHop = Dest;
  } else {
    NextHop = RtEntry->NextHop;
  }

  Ip4FreeRouteEntry (RtEntry);

  //
  // Create a route cache entry, and tag it as spawned from this route entry
  //
  RtCacheEntry = Ip4CreateRouteCacheEntry (Dest, Src, NextHop, (UINTN) RtEntry);

  if (RtCacheEntry == NULL) {
    return NULL;
  }

  NetListInsertHead (Head, &RtCacheEntry->Link);
  NET_GET_REF (RtCacheEntry);

  //
  // Each bucket of route cache can contain at most 64 entries.
  // Remove the entries at the tail of the bucket. These entries
  // are likely to be used least.
  //
  Count = 0;
  NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) {
    if (++Count < IP4_ROUTE_CACHE_MAX) {
      continue;
    }

    Cache = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link);

    NetListRemoveEntry (Entry);
    Ip4FreeRouteCacheEntry (Cache);
  }

  return RtCacheEntry;
}

EFI_STATUS
Ip4BuildEfiRouteTable (
  IN IP4_PROTOCOL           *IpInstance
  )
/*++

Routine Description:

  Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of 
  GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the 
  internal operation of the IP4 driver.

Arguments:

  IpInstance  - The IP4 child that requests the route table.

Returns:

  EFI_SUCCESS          - The route table is successfully build
  EFI_OUT_OF_RESOURCES - Failed to allocate the memory for the rotue table.

--*/
{
  IP4_SERVICE               *IpSb;
  NET_LIST_ENTRY            *Entry;
  IP4_ROUTE_TABLE           *RtTable;
  IP4_ROUTE_ENTRY           *RtEntry;
  EFI_IP4_ROUTE_TABLE       *Table;
  UINT32                    Count;
  INT32                     Index;

  IpSb    = IpInstance->Service;
  RtTable = IpInstance->RouteTable;

  if (IpInstance->EfiRouteTable != NULL) {
    NetFreePool (IpInstance->EfiRouteTable);
    
    IpInstance->EfiRouteTable = NULL;
    IpInstance->EfiRouteCount = 0;
  }

  Count = RtTable->TotalNum;

  if (RtTable->Next != NULL) {
    Count += RtTable->Next->TotalNum;
  }

  if (Count == 0) {
    return EFI_SUCCESS;
  }

  Table = NetAllocatePool (sizeof (EFI_IP4_ROUTE_TABLE) * Count);

  if (Table == NULL) {
    return EFI_OUT_OF_RESOURCES;
  }
  
  //
  // Copy the route entry to EFI route table. Keep the order of
  // route entry copied from most specific to default route. That
  // is, interlevel the route entry from the instance's route area
  // and those from the default route table's route area.
  //
  Count = 0;
  
  for (Index = IP4_MASK_NUM - 1; Index >= 0; Index--) {
    for (RtTable = IpInstance->RouteTable; RtTable != NULL; RtTable = RtTable->Next) {
      NET_LIST_FOR_EACH (Entry, &(RtTable->RouteArea[Index])) {
        RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link);

        EFI_IP4 (Table[Count].SubnetAddress)  = HTONL (RtEntry->Dest & RtEntry->Netmask);
        EFI_IP4 (Table[Count].SubnetMask)     = HTONL (RtEntry->Netmask);
        EFI_IP4 (Table[Count].GatewayAddress) = HTONL (RtEntry->NextHop);

        Count++;
      }
    }
  }

  IpInstance->EfiRouteTable = Table;
  IpInstance->EfiRouteCount = Count;
  return EFI_SUCCESS;
}
